CorrelationCommand Constructor(RasterImage,LeadPoint[],int,int,int)

Summary

Initializes a new CorrelationCommand class object with explicit parameters.

Syntax

Objective-C

C++

Java

public CorrelationCommand( 
   RasterImage correlationImage, 
   LeadPoint[] points, 
   int xStep, 
   int yStep, 
   int threshold 
)

Public Function New( _ 
   ByVal correlationImage As RasterImage, _ 
   ByVal points() As LeadPoint, _ 
   ByVal xStep As Integer, _ 
   ByVal yStep As Integer, _ 
   ByVal threshold As Integer _ 
)

- (instancetype)initWithCorrelationImage:(nullable LTRasterImage *)correlationImage 
                                  points:(nullable LeadPoint *)points 
                             pointsCount:(NSUInteger)pointsCount 
                                   xStep:(NSUInteger)xStep 
                                   yStep:(NSUInteger)yStep 
                               threshold:(NSUInteger)threshold

public CorrelationCommand( 
   RasterImage correlationImage,  
   LeadPoint[] points,  
   int xStep,  
   int yStep,  
   int threshold 
)

public: 
CorrelationCommand(  
   RasterImage^ correlationImage, 
   array<LeadPoint>^ points, 
   int xStep, 
   int yStep, 
   int threshold 
)

Parameters

correlationImage
RasterImage object that references the image for which to search.

points
An array of LeadPoint structures. This array will be updated with the starting points for the correlated areas.

xStep
Step size in the X direction (along image width), in pixels. For best results, use 1. This parameter accepts only positive values.

yStep
Step size in the Y direction (along image height), in pixels. For best results, use 1. This parameter accepts only positive values.

threshold
Value that indicates the correlation threshold, which is a measure of association required to consider two areas to be correlated. If the correlation value between correlationImage and an area in the image to be searched (the Run method image) is less than the correlation threshold they are u ncorrelated. Valid values range from 0 (zero resemblance) to 100 (perfect resemblance).

Example

Run the CorrelationCommand on an image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
public void CorrelationConstructorExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "clean.tif")); 
 
   // Prepare the command 
   RasterImage dstImage = image.Clone(); 
   LeadPoint[] points = new LeadPoint[90]; 
 
   CorrelationCommand command = new CorrelationCommand(dstImage, points, 1, 1, 70); 
   // Apply the correlation filter. 
   command.Run(image); 
 
   MessageBox.Show("The number of points are:" + command.NumberOfPoints.ToString()); 
 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
 
Public Sub CorrelationConstructorExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "clean.tif")) 
 
   ' Prepare the command 
   Dim points() As LeadPoint 
   ReDim points(89) 
 
   Dim DstImage As RasterImage = leadImage.Clone() 
   Dim command As CorrelationCommand = New CorrelationCommand(DstImage, points, 1, 1, 70) 
   ' Apply the correlation filter. 
   command.Run(leadImage) 
 
   MessageBox.Show("The number of points are:" & command.NumberOfPoints.ToString()) 
 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Examples; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.Core; 
 
public void CorrelationConstructorExample(RasterImage image, Stream outStream) 
{ 
   // Prepare the command 
   RasterImage dstImage = image.Clone(); 
   LeadPoint[] points = new LeadPoint[90]; 
 
   CorrelationCommand command = new CorrelationCommand(dstImage, points, 1, 1, 70); 
   // Apply the correlation filter. 
   command.Run(image); 
   Debug.WriteLine("The number of points are:" + command.NumberOfPoints.ToString()); 
 
   // Save result image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24); 
   image.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Core 
 
Public Sub CorrelationConstructorExample(ByVal image As RasterImage, ByVal outStream As Stream) 
   ' Prepare the command 
   Dim dstImage As RasterImage = image.Clone() 
   Dim points As LeadPoint() = New LeadPoint(89) {} 
 
   Dim command As CorrelationCommand = New CorrelationCommand(dstImage, points, 1, 1, 70) 
   ' Apply the correlation filter. 
   command.Run(image) 
   Debug.WriteLine("The number of points are:" & command.NumberOfPoints.ToString()) 
 
   ' Save result image 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, outStream, RasterImageFormat.Jpeg, 24) 
   image.Dispose() 
End Sub

Requirements

Target Platforms

Reference

CorrelationCommand Class

CorrelationCommand Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.4.3